Package com.cisco.pt.ipc.sim.impl
Class ClusterImpl
java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.ClusterImpl
Information provided by the PKI file:
\class Cluster
\brief Clusters used to group clusters inside logical workspace
- Author:
- Auto-generated
-
Field Summary
Fields inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
accessMessage, ipcFactory, packetTracerSession -
Constructor Summary
ConstructorsConstructorDescriptionClusterImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage) -
Method Summary
Modifier and TypeMethodDescriptiondoubleInformation provided by the PKI file:doubleInformation provided by the PKI file:getChildClusterAt(int index) Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:getId()Information provided by the PKI file:getName()Information provided by the PKI file:Information provided by the PKI file:doubleInformation provided by the PKI file:doubleInformation provided by the PKI file:booleanmoveToLocation(int x, int y) Information provided by the PKI file:booleanmoveToLocationCentered(int x, int y) Information provided by the PKI file:voidsetIconPath(String str) Information provided by the PKI file:voidInformation provided by the PKI file:Methods inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession, sendMessage, sendMessageWithReturn, translateToCommandStatusStringPairMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Constructor Details
-
ClusterImpl
public ClusterImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage)
-
-
Method Details
-
setName
Information provided by the PKI file:
\brief Allows to change cluster name to newName. \param newName, name to use. -
getName
Information provided by the PKI file:
\brief Returns cluster name. \return QString, value is the cluster name. -
getId
Information provided by the PKI file:
\brief Returns cluster ID. \return QString, value is the ID of the cluster. -
getChildClusterCount
public int getChildClusterCount()Information provided by the PKI file:
\brief Returns the number of child cluster objects \return int, the number of child clusters inside the cluster.- Specified by:
getChildClusterCountin interfaceCluster- Returns:
- int Returns a int
-
getChildClusterAt
Information provided by the PKI file:
\brief Returns child cluster object at a given index \param index, the index of child cluster to return. \return Cluster, value is the child cluster at the given index. Range(0, getContainerCount()-1)- Specified by:
getChildClusterAtin interfaceCluster- Parameters:
index- Takes in a parameter of index- Returns:
- Cluster Returns a Cluster
-
getParentCluster
Information provided by the PKI file:
\brief Returns parent cluster object \return Cluster, value is the parent of the cluster.- Specified by:
getParentClusterin interfaceCluster- Returns:
- Cluster Returns a Cluster
-
getXCoordinate
public double getXCoordinate()Information provided by the PKI file:
\brief Returns the current x-coordinate position in the Logical workspace for this cluster. \return double, the current x-coordinate.- Specified by:
getXCoordinatein interfaceCluster- Returns:
- double Returns a double
-
getYCoordinate
public double getYCoordinate()Information provided by the PKI file:
\brief Returns the current y-coordinate position in the Logical workspace for this cluster. \return double, the current y-coordinate.- Specified by:
getYCoordinatein interfaceCluster- Returns:
- double Returns a double
-
getCenterXCoordinate
public double getCenterXCoordinate()Information provided by the PKI file:
\brief Returns the current x-coordinate position in the Logical workspace for this cluster. \return double, the current x-coordinate.- Specified by:
getCenterXCoordinatein interfaceCluster- Returns:
- double Returns a double
-
getCenterYCoordinate
public double getCenterYCoordinate()Information provided by the PKI file:
\brief Returns the current y-coordinate position in the Logical workspace for this cluster. \return double, the current y-coordinate.- Specified by:
getCenterYCoordinatein interfaceCluster- Returns:
- double Returns a double
-
moveToLocationCentered
public boolean moveToLocationCentered(int x, int y) Information provided by the PKI file:
\brief Moves this cluster to the specified location for its center in Logical workspace. \param x, the new x-coordinate position. \param y, the new y-coordinate position. \return bool, true if successful, otherwise false.- Specified by:
moveToLocationCenteredin interfaceCluster- Parameters:
x- Takes in a parameter of xy- Takes in a parameter of y- Returns:
- boolean Returns a boolean
-
moveToLocation
public boolean moveToLocation(int x, int y) Information provided by the PKI file:
\brief Moves this cluster to the specified location in Logical workspace. \param x, the new x-coordinate position. \param y, the new y-coordinate position. \return bool, true if successful, otherwise false.- Specified by:
moveToLocationin interfaceCluster- Parameters:
x- Takes in a parameter of xy- Takes in a parameter of y- Returns:
- boolean Returns a boolean
-
setIconPath
Information provided by the PKI file:
\brief Sets the icon to use for the cluster. \param str, path to the image to use for the cluster icon.- Specified by:
setIconPathin interfaceCluster- Parameters:
str- Takes in a parameter of str
-
getIconPath
Information provided by the PKI file:
\brief Returns the path to the image to use for the cluster icon. \return QString, the cluster image icon path.- Specified by:
getIconPathin interfaceCluster- Returns:
- String Returns a String
-